LimsAccessionsIndexFor (Method)

Description

This index method provides an array of CoreOne Lims Accessions that are associated with a specified herd.

Request (LimsAccessionsIndexFor)

Below are the required parameters to successfully return an array of CoreOne Lims Accessions that fall within a specified time frame and belong to a specified herd. If any parameter is omitted an error message will be displayed alerting the user.

Request Body Parameters

Name

Description

Data Type

token

This is a 40-character hexadecimal string.

This token should have been obtained at the commencement of a session using the Login (Method). It is required for all functional CoreOne web services.

xml:string

herd_id

This is an internal CoreOne Herd id. This can be used to display a list of Lims Accessions that are associated with a specified Herd. It is a required parameter.

These can be retrieved through using the HerdIndex (Method).

xml:int

start_date

This is used as the start date of a time frame to return Lims Accessions that where created after this specified date. It is a required parameter and must be in format YYYY-MM-DD.

xml:date

end_date

This is used as the end date of a time frame to return Lims Accessions that where created before this specified date. It is a required parameter and must be in format YYYY-MM-DD.

xml:date

Response (LimsAccessionsIndexFor_response)

This will return a list of CoreOne Lims Accessions along with a summary of each Lims Accession's details.

To get more comprehensive details on a specific CoreOne Lims Accession use the LimsAccessionsShow(Method).

Response Body Parameters

Name	Description	Data Type
lims_accession	This is an array which shows the details for each CoreOne Lims Accession returned.	ws_lims_accession_f

Remarks